home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / sspevx.z / sspevx
Encoding:
Text File  |  2002-10-03  |  7.6 KB  |  199 lines
  1.  
  2.  
  3.  
  4. SSSSSSSSPPPPEEEEVVVVXXXX((((3333SSSS))))                                                          SSSSSSSSPPPPEEEEVVVVXXXX((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      SSPEVX - compute selected eigenvalues and, optionally, eigenvectors of a
  10.      real symmetric matrix A in packed storage
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      SUBROUTINE SSPEVX( JOBZ, RANGE, UPLO, N, AP, VL, VU, IL, IU, ABSTOL, M,
  14.                         W, Z, LDZ, WORK, IWORK, IFAIL, INFO )
  15.  
  16.          CHARACTER      JOBZ, RANGE, UPLO
  17.  
  18.          INTEGER        IL, INFO, IU, LDZ, M, N
  19.  
  20.          REAL           ABSTOL, VL, VU
  21.  
  22.          INTEGER        IFAIL( * ), IWORK( * )
  23.  
  24.          REAL           AP( * ), W( * ), WORK( * ), Z( LDZ, * )
  25.  
  26. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  27.      These routines are part of the SCSL Scientific Library and can be loaded
  28.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  29.      directs the linker to use the multi-processor version of the library.
  30.  
  31.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  32.      4 bytes (32 bits). Another version of SCSL is available in which integers
  33.      are 8 bytes (64 bits).  This version allows the user access to larger
  34.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  35.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  36.      only one of the two versions; 4-byte integer and 8-byte integer library
  37.      calls cannot be mixed.
  38.  
  39. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  40.      SSPEVX computes selected eigenvalues and, optionally, eigenvectors of a
  41.      real symmetric matrix A in packed storage. Eigenvalues/vectors can be
  42.      selected by specifying either a range of values or a range of indices for
  43.      the desired eigenvalues.
  44.  
  45.  
  46. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  47.      JOBZ    (input) CHARACTER*1
  48.              = 'N':  Compute eigenvalues only;
  49.              = 'V':  Compute eigenvalues and eigenvectors.
  50.  
  51.      RANGE   (input) CHARACTER*1
  52.              = 'A': all eigenvalues will be found;
  53.              = 'V': all eigenvalues in the half-open interval (VL,VU] will be
  54.              found; = 'I': the IL-th through IU-th eigenvalues will be found.
  55.  
  56.      UPLO    (input) CHARACTER*1
  57.              = 'U':  Upper triangle of A is stored;
  58.              = 'L':  Lower triangle of A is stored.
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. SSSSSSSSPPPPEEEEVVVVXXXX((((3333SSSS))))                                                          SSSSSSSSPPPPEEEEVVVVXXXX((((3333SSSS))))
  71.  
  72.  
  73.  
  74.      N       (input) INTEGER
  75.              The order of the matrix A.  N >= 0.
  76.  
  77.      AP      (input/output) REAL array, dimension (N*(N+1)/2)
  78.              On entry, the upper or lower triangle of the symmetric matrix A,
  79.              packed columnwise in a linear array.  The j-th column of A is
  80.              stored in the array AP as follows:  if UPLO = 'U', AP(i + (j-
  81.              1)*j/2) = A(i,j) for 1<=i<=j; if UPLO = 'L', AP(i + (j-1)*(2*n-
  82.              j)/2) = A(i,j) for j<=i<=n.
  83.  
  84.              On exit, AP is overwritten by values generated during the
  85.              reduction to tridiagonal form.  If UPLO = 'U', the diagonal and
  86.              first superdiagonal of the tridiagonal matrix T overwrite the
  87.              corresponding elements of A, and if UPLO = 'L', the diagonal and
  88.              first subdiagonal of T overwrite the corresponding elements of A.
  89.  
  90.      VL      (input) REAL
  91.              VU      (input) REAL If RANGE='V', the lower and upper bounds of
  92.              the interval to be searched for eigenvalues. VL < VU.  Not
  93.              referenced if RANGE = 'A' or 'I'.
  94.  
  95.      IL      (input) INTEGER
  96.              IU      (input) INTEGER If RANGE='I', the indices (in ascending
  97.              order) of the smallest and largest eigenvalues to be returned.  1
  98.              <= IL <= IU <= N, if N > 0; IL = 1 and IU = 0 if N = 0.  Not
  99.              referenced if RANGE = 'A' or 'V'.
  100.  
  101.      ABSTOL  (input) REAL
  102.              The absolute error tolerance for the eigenvalues.  An approximate
  103.              eigenvalue is accepted as converged when it is determined to lie
  104.              in an interval [a,b] of width less than or equal to
  105.  
  106.              ABSTOL + EPS *   max( |a|,|b| ) ,
  107.  
  108.              where EPS is the machine precision.  If ABSTOL is less than or
  109.              equal to zero, then  EPS*|T|  will be used in its place, where
  110.              |T| is the 1-norm of the tridiagonal matrix obtained by reducing
  111.              AP to tridiagonal form.
  112.  
  113.              Eigenvalues will be computed most accurately when ABSTOL is set
  114.              to twice the underflow threshold 2*SLAMCH('S'), not zero.  If
  115.              this routine returns with INFO>0, indicating that some
  116.              eigenvectors did not converge, try setting ABSTOL to
  117.              2*SLAMCH('S').
  118.  
  119.              See "Computing Small Singular Values of Bidiagonal Matrices with
  120.              Guaranteed High Relative Accuracy," by Demmel and Kahan, LAPACK
  121.              Working Note #3.
  122.  
  123.      M       (output) INTEGER
  124.              The total number of eigenvalues found.  0 <= M <= N.  If RANGE =
  125.              'A', M = N, and if RANGE = 'I', M = IU-IL+1.
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. SSSSSSSSPPPPEEEEVVVVXXXX((((3333SSSS))))                                                          SSSSSSSSPPPPEEEEVVVVXXXX((((3333SSSS))))
  137.  
  138.  
  139.  
  140.      W       (output) REAL array, dimension (N)
  141.              If INFO = 0, the selected eigenvalues in ascending order.
  142.  
  143.      Z       (output) REAL array, dimension (LDZ, max(1,M))
  144.              If JOBZ = 'V', then if INFO = 0, the first M columns of Z contain
  145.              the orthonormal eigenvectors of the matrix A corresponding to the
  146.              selected eigenvalues, with the i-th column of Z holding the
  147.              eigenvector associated with W(i).  If an eigenvector fails to
  148.              converge, then that column of Z contains the latest approximation
  149.              to the eigenvector, and the index of the eigenvector is returned
  150.              in IFAIL.  If JOBZ = 'N', then Z is not referenced.  Note: the
  151.              user must ensure that at least max(1,M) columns are supplied in
  152.              the array Z; if RANGE = 'V', the exact value of M is not known in
  153.              advance and an upper bound must be used.
  154.  
  155.      LDZ     (input) INTEGER
  156.              The leading dimension of the array Z.  LDZ >= 1, and if JOBZ =
  157.              'V', LDZ >= max(1,N).
  158.  
  159.      WORK    (workspace) REAL array, dimension (8*N)
  160.  
  161.      IWORK   (workspace) INTEGER array, dimension (5*N)
  162.  
  163.      IFAIL   (output) INTEGER array, dimension (N)
  164.              If JOBZ = 'V', then if INFO = 0, the first M elements of IFAIL
  165.              are zero.  If INFO > 0, then IFAIL contains the indices of the
  166.              eigenvectors that failed to converge.  If JOBZ = 'N', then IFAIL
  167.              is not referenced.
  168.  
  169.      INFO    (output) INTEGER
  170.              = 0:  successful exit
  171.              < 0:  if INFO = -i, the i-th argument had an illegal value
  172.              > 0:  if INFO = i, then i eigenvectors failed to converge.  Their
  173.              indices are stored in array IFAIL.
  174.  
  175. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  176.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  177.  
  178.      This man page is available only online.
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.